/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.common;

import java.io.Serializable;
import java.util.List;

/**
 *  * Data Access Object.<br>
 * Instancias desta interface são utilizadas pelas transações, editores e buscas
 * da API balisunrise.
 * @author Glauco
 * @param <T> Tipo do Objeto de Session
 */
public interface DAO<T> {

    /**
     * Retorna um objeto de sessão para acesso ao banco de dados.
     * @return
     */
    public T getSession();

    /**
     * Abre a sessão.
     */
    public void openSession();

    /**
     * Fecha a sessão.
     */
    public void closeSession();

    /**
     * Retorna o Objeto Id de uma entidade.
     * @param entity Entidade.
     * @return Id da Entidade.
     */
    public Serializable getId(Object entity);

    /**
     * Salva a entidade no banco de dados. persistir. Insert ou Update.
     * @param entity
     */
    public void save(Object entity);

    /**
     * Le uma entidade do banco de dados
     * @param c Classe da Entidade que deve ser lida.
     * @param key ID da entidade.
     * @return Retorna a entidade ou null caso não encontre nenhuma entidade
     * para o ID.
     */
    public Object read(Class c, Serializable key);

    /**
     * Exclui uma entidade do banco de dados.
     * @param entity Entidade que deve ser excluída.
     */
    public void delete(Object entity);

    /**
     * Busca todas entidades de uma determinada classe.
     * @param entityClass Classe da entidade que deve ser buscada.
     * @return Uma lista das entidades.
     */
    public List list(Class entityClass);

    /**
     * Busca entidades do banco de dados atravéz de uma query.
     * @param query Query para buscar as entidades.
     * @return Uma lista de entidades.
     * @see org.balisunrise.common.Query
     */
    public List list(Query query);
}
